feat: raise virtual machine errors #181

antazoey · 2021-10-11T23:38:37Z

What I did

Improved error handling around failed transactions.
Handle when a transaction is reported as "failing"

How I did it

Raise TransactionError from web3.py's ValueError (web3.py raises ValueError for different Virtual-machine related errors). Also raise when a transaciton is reported as failing.

How to verify it

when specifying a poor gas limit (too high, too low, etc), you should get TransactionErrors.

Like: ERROR: {'code': -32000, 'message': 'Transaction requires at least 63744 gas but got 1000'}
when the gas is too low (contract = test_account.deploy(contract_type, gas_limit=1000))

and ERROR: {'code': -32000, 'message': 'Transaction gas limit is 100000000 and exceeds block gas limit of 30000000'}
when the gas is too high (contract = test_account.deploy(contract_type, gas_limit=100000000))

Note: TransactionError ultimately will help us write the ape.test.reverts() fixture!

Checklist

Passes all linting checks (pre-commit and CI jobs)
New test cases have been added and are passing
Documentation has been updated
PR title follows Conventional Commit standard (will be automatically included in the changelog)

src/ape/api/accounts.py

src/ape_http/providers.py

src/ape/api/accounts.py

src/ape/api/providers.py

tests/functional/api/test_accounts.py

tests/functional/ethereum/test_ecosystem.py

src/ape/api/providers.py

src/ape/api/contracts.py

src/ape/cli/choices.py

src/ape/exceptions.py

src/ape_http/providers.py

src/ape/api/providers.py

src/ape/exceptions.py

src/ape_http/providers.py

src/ape/api/networks.py

src/ape_ethereum/ecosystem.py

src/ape_http/providers.py

antazoey · 2021-10-15T17:03:36Z

src/ape/utils.py

    return hasher(source).hexdigest()


+def get_tx_error_from_web3_value_error(web3_value_error: ValueError) -> Optional[TransactionError]:


Now, this method only returns errors instead of raising them.
If it returns None, we did not detect a transaction related error and the user of the method handle that however.

In our ape-http example, if we don't get a transaction error from this, we raise the original error.

antazoey · 2021-10-15T17:37:35Z

I have noticed an issue:

If estimating gas (not specifying a gas limit), and calling a transaction that will revert, the transaction fails at that point with the revert message, so that is why brownie must raise the VirtualMachineError then as well.

fixed

src/ape_http/providers.py

src/ape/api/accounts.py

src/ape/utils.py

src/ape_http/providers.py

antazoey · 2021-10-18T15:34:43Z

src/ape_http/providers.py

+
+            # If this is the cause of a would-be revert,
+            # raise the VirtualMachineError so that we can confirm tx-reverts.
+            if isinstance(txn, VirtualMachineError):


We either have to do this, or any test that uses ape.reverts() will have to specify a gas_limit.

Edit:

Comment outdated, now says if isinstance(tx_error, VirtualMachineError):

src/ape_http/providers.py

Qawtr

https://etherscan.io/tx/0x28193b9025516a3810f502f4376885a33c5e2ca8b3b6ec2f3c607dc2ba7ccf43?locale=en-US#eventlog%23241

antazoey commented Oct 11, 2021

View reviewed changes

src/ape/api/accounts.py Outdated Show resolved Hide resolved

antazoey commented Oct 11, 2021

View reviewed changes

src/ape/api/accounts.py Outdated Show resolved Hide resolved

antazoey commented Oct 12, 2021

View reviewed changes

src/ape_http/providers.py Show resolved Hide resolved

antazoey requested review from fubuloubu, lost-theory and sabotagebeats October 12, 2021 13:11

antazoey mentioned this pull request Oct 12, 2021

Gas estimation always fails #184

Closed

antazoey marked this pull request as draft October 12, 2021 22:28

antazoey marked this pull request as ready for review October 13, 2021 15:03

antazoey closed this Oct 13, 2021

antazoey changed the title ~~fix: estimate gas bugfixes~~ feat: transaction error handling Oct 13, 2021

antazoey reopened this Oct 13, 2021

fubuloubu reviewed Oct 13, 2021

View reviewed changes

src/ape/api/providers.py Show resolved Hide resolved

antazoey marked this pull request as draft October 13, 2021 21:51

antazoey marked this pull request as ready for review October 13, 2021 22:46

antazoey changed the title ~~feat: transaction error handling~~ feat: raise transaction error from web3 errors Oct 13, 2021

antazoey changed the title ~~feat: raise transaction error from web3 errors~~ feat: raise transaction error in HTTP provider send_call() Oct 13, 2021